文档

开放API 调用和状态码

更新时间:
一键部署

1. API 接口调用

阿里云IoT 提供的一套开放HTTP 服务, 具体API 的调用请参加 API调用对接指引

2. HTTP 状态码

  • HTTP 服务调用都有相对应的返回码, 具体HTTP 返回码如下:

响应类型

HTTP状态码

场景

正常

200

后端服务顺利返回,没有出现异常,或者即使有异常,也符合预期。注意,业务失败不允许用200返回,请使用400错误码。

后端服务异常

500

后端服务返回:Internal Error。错误码没有映射到,返回默认错误码。

服务端无法完成请求

501

服务器不支持请求的功能,无法完成请求。

服务不可用

503

网关调用后端服务失败,后端服务不可用。

入参缺失

400

必传参数缺失。有些可选参数在特定业务场景下缺失。

入参非法

400

参数格式不正确,比如:日期、数字、大小写不正确,长度问题等造成的。特定业务参数校验失败,比如参数内容不符合接口要求、或者JSON和RepeatList格式的入参,不满足接口要求。 * 增加URL、域名、字符串格式合法性校验。

账户验证失败

400

账户欠费。余额不足。 * 风控问题。业务失败的错误码统一使用400。

无权操作

403

RAM校验不通过访问控制。用户无权执行此操作。

越权操作

403

资源鉴权不通过(资源存在并归属于其他账号,不存在的参考资源不存在)。

SQL错误

403

【强制】产品内部系统的SQL错误不应透出给用户,应使用 500 错误。SQL语法错误。 * SQL超时错误。

流控

429

系统流控:超过了系整体流控的阈值。用户流控:单位时间内单个用户访问次数达到了上线。业务规则流控:用户调用超过了业务方规则限制。IP流控。

资源不存在

404

获取单个资源信息时,若不存在。删除时若资源已不存在提示404。如:InvalidInstanceId.NotFound

  • 本页导读 (0)